Skip to content

chore: add package support metadata#65

Merged
chenjiahan merged 1 commit into
rstackjs:mainfrom
YfengJ:codex/package-support-metadata
Jun 18, 2026
Merged

chore: add package support metadata#65
chenjiahan merged 1 commit into
rstackjs:mainfrom
YfengJ:codex/package-support-metadata

Conversation

@YfengJ

@YfengJ YfengJ commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add npm homepage metadata pointing to the project README
  • add npm bugs metadata pointing to the GitHub issues page

Why

The currently published @rsbuild/plugin-umd package exposes its name, version, and repository on npm, but not homepage or bugs links. Adding these fields makes it easier for npm/package consumers to find documentation and report issues directly from package metadata.

Validation

  • node -e "const pkg=require('./package.json'); if(pkg.homepage!=='https://github.com/rstackjs/rsbuild-plugin-umd#readme') throw new Error('bad homepage'); if(!pkg.bugs || pkg.bugs.url!=='https://github.com/rstackjs/rsbuild-plugin-umd/issues') throw new Error('bad bugs url'); console.log(JSON.stringify({homepage:pkg.homepage,bugs:pkg.bugs}, null, 2));"
  • npm view @rsbuild/plugin-umd@latest name version repository.url homepage bugs --json
  • pnpm install --frozen-lockfile --ignore-scripts
  • pnpm run lint
  • pnpm run build
  • pnpm run test
  • npm pack --dry-run --ignore-scripts --json .
  • git diff --check

@coderabbitai

coderabbitai Bot commented Jun 18, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 0d9e7061-cffa-4800-ba57-2cfcc6ce12e4

📥 Commits

Reviewing files that changed from the base of the PR and between 5e284ac and e240ccf.

📒 Files selected for processing (1)
  • package.json

📝 Walkthrough

Walkthrough

The package.json manifest gains two new metadata fields: a homepage field pointing to the README URL and a bugs object containing a url field pointing to the repository's issues page. No other fields, scripts, or dependencies are modified.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'chore: add package support metadata' accurately summarizes the main change of adding homepage and bugs fields to package.json.
Description check ✅ Passed The description is clearly related to the changeset, providing context about why the metadata fields are being added and comprehensive validation steps.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@chenjiahan chenjiahan merged commit 19f3691 into rstackjs:main Jun 18, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants